Skip to content

Update from code changes: document API Playground variables - #6882

Merged
ethanpalm merged 3 commits into
mainfrom
mintlify/document-api-playground-server-variables
Aug 10, 2026
Merged

Update from code changes: document API Playground variables#6882
ethanpalm merged 3 commits into
mainfrom
mintlify/document-api-playground-server-variables

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new client API for pre-filling OpenAPI API Playground server variables from custom JavaScript.

Changes

  • Covers setting, replacing, clearing, queuing, and live application of runtime server-variable values
  • Explains authentication and tenant-switch use cases, session-only behavior, fallback precedence, and non-secret requirements
  • Adds matching Spanish, French, and Chinese guidance

Context

The triggering source change exposes these methods under window.mintlify.api.playground.

https://github.com/mintlify/mint/pull/9823


Note

Low Risk
Documentation-only changes to MDX; no runtime or application code is modified.

Overview
Documents how custom JavaScript can drive OpenAPI server variables in the API Playground via window.mintlify.api.playground.setServerVariables and clearServerVariables.

The new Set API Playground server variables section explains post-load use cases (auth, tenant switches), that each call replaces runtime overrides with precedence over OpenAPI defaults and saved values, pre-init call queuing, session-scoped behavior until full refresh, and warnings against putting secrets in server variables. Page description and keywords are updated in all four locales; Spanish, French, and Chinese pages add the same guidance with locale-specific detail (e.g. omitted keys, no localStorage writes) where the English page is shorter.

Reviewed by Cursor Bugbot for commit 049f812. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🔴 Failed Aug 10, 2026, 10:16 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Aug 5, 2026, 7:31 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread customize/custom-scripts.mdx Outdated
Comment thread customize/custom-scripts.mdx Outdated
Comment thread customize/custom-scripts.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@mintlify-development

mintlify-development Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
userauth 🔴 Failed Aug 10, 2026, 9:39 PM

@mintlify-development

mintlify-development Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
prosignuptest 🔴 Failed Aug 10, 2026, 9:39 PM

@mintlify-development

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟡 Building Aug 10, 2026, 9:38 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify-development

mintlify-development Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
testing 🔴 Failed Aug 10, 2026, 9:47 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@ethanpalm
ethanpalm merged commit 6c5edc2 into main Aug 10, 2026
5 of 6 checks passed
@ethanpalm
ethanpalm deleted the mintlify/document-api-playground-server-variables branch August 10, 2026 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants